What is a Link?

A link is a connection to another page or additional information that helps expand the users understanding of the data. In DiveTab, links can be added to certain locations on tabular and free-form layout pages and lead to a variety of information types.

Links can be configured to be active only if certain conditions are met. These are called conditionalized links.

NOTE: Data pages can be linked automatically to central pages depending on which dimensions are supported by the central page.

Links can be added to:

  • Charts
  • Grids
  • Tables
  • Tabular pages

There are several types of links:

  • DivePort—Opens a DivePort portal, at a specific page, which can be determined by a column value.
  • Document—Opens a file, typically a document, which can be determined by a column value.
  • External Page—Opens a specified page contained in an outside data area, identified both by the area id and page id.
  • External Central Page—Applies a central page that is defined in an external data area to the entire data area.
  • Map—Opens a map site pointing to a specific location, which can be determined by a column value. The map location can be identified by latitude and longitude coordinates.
  • Page—Opens the identified DiveTab page. Use id to link to a DiveTab within the same data area, or use area-id and id to identify an external data-area and the corresponding page.
  • Web Page—Opens the DiveTab browser to the specified website, which can be determined by a column value.

NOTE: The following examples use hard-coded values. Typically, such values are built into cBases or cPlans for flexibility.

A DivePort link leads to a DivePort portal.

Here is an example of a Closedcolumn that links to a DivePort page.

Example of a page using a DivePort link.

Here is the Closedresult of the link in DiveTab.

The resulting linked DivePort page.

Here is how the page appears in the code.

  report-page { 
    title "DivePort Link" 
    cplan "/cplans/distributor-dev.cplan" 
    
    dimension "Division Manager" 
    text column = "Bottles" 
    text "DivePort" { 
      link { 
        diveport { 
          url "https://docs.dimins.com/diveport-docs" 
          page "fed45dc0-0340-463b-9362-786a8b66a0d2" 
        } 
      } 
    } 
  }

See also: DivePort Links.

A document link opens a file.

Here is an example of a Closedcolumn that opens a file.

Example of a page with a document link.

Here is the Closedresult of the link in DiveTab.

The resulting linked document.

Here is how the page appears in the code.

  report-page { 
    title "Documents Link" 
    cplan "/cplans/distributor-dev.cplan" 
    
    dimension "Division Manager" 
    text column = "Bottles" 
    text "Guide" { 
      link { 
        document { 
          repository "documents" 
          path "DiveTabUserGuidePC70.pdf" 
        } 
      } 
    } 
  }

See also: Document Links.

An external data area page link opens a page defined in an external data area from the current page. Central pages are one type of external data area page, with report, ad hoc, cross, dive, and overview pages defined differently from central pages.

Here is an example of a Closedreport page that links to an external data area report page.

Example of a Report page with a link to an external data area Report page.

Here is the Closedresulting report page.

The resulting linked report page.

Report, dive, cross, ad hoc, and overview pages are defined as the data script's page area-id and the data area block id. The page area-id specifies the external script, and the block id specifies the exact block within the external script.

Here is how the Closedinitial report page appears in the code.

      report-page { 
        title "External Data Area Page Link" 
        cplan "/cplans/basic_101.cplan" 
        dimension "Corporate Product Group" 
        text column = "Cases" { 
          link { 
            page area-id = "data-area-landing" id = "rp-corporate-product-group-detail" 
          } 
        } 
      }

Here is how Closedlinked report page appears in the code.

  data-area id = "data-area-landing" {
    title "External Page Links: <br> Data Areas"
    icon "divetab/images/menu icons/17.png"

    sections {
      report-page id = "rp-corporate-product-group-detail" {
        title "Corporate Product Group Details"
        cplan "/cplans/basic_101.cplan"
        
        parameter "Corporate Product Group"
        
        dimension "Resp SalesPerson"
        dimension "Premise"
        
        text "9L Cases" column = "9 Liter Cases"
      }
    }
  }

NOTE: External central page links are coded differently.

Here is an example of a Closedreport page that links to an external data area central page.

Example of a report page with a link to an external data area central page.

Here is the Closedresulting central page.

The resulting linked central page.

External central page links are specified in the data-area block. The external-central-page id specifies the central page block, and the area-id refers to the data area script.

Here is how the Closedinitial report page appears in the code.

  data-area id="data-area-1" device-type = "all" {
    title "Linking" 
    icon "/divetab/images/menu icons/33.png" 
    external-central-page id = "cp-corporate-supplier-details" area-id = "data-area-landing" 
    
    sections { 
      report-page {
        title "External Data Area Page Link - Central Page" 
        cplan "/cplans/basic_101.cplan" 
        
        dimension "Corporate Supplier" 
        dimension "Corporate Product Group" 
        text column = "Cost" 
        text column = "Net Sales"
      }
    } 
  }

Here is how the Closed linked central page appears in the code.

  definitions {
    elements {
      pie-chart id = "pc-respteam" {
        title "Resp Team x Cases"
        dimension "Resp Team"
        column column = "Cases"
      }
            
      line-chart id = "ln-brand" {
        title "Corporate Brand"
        dimension "Corporate Brand"
        line column = "Net Sales"
        line column = "Cost"
        line column = "Discount"
      }
      
      table id = "tb-customer" {
        title "Customers"
        dimension "Customer"
        text column = "Cases"
        text column = "Cost" {
          value-format "$#,###.00"
        }
      }
    }
  }
  
  data-area id = "data-area-landing" {
    title "Central Example"
    icon "/divetab/images/menu icons/5.png" 
    
    sections {
      report-page {
        ...
      }
    }
    
    pages {
      central-page id = "cp-corporate-supplier-details" {
        cplan "/cplans/basic_timeseries.cplan"
        
        dimension "Customer"
        dimension "Product Name"
        dimension "Corporate Supplier"
        
        quickview-set {
          cplan "/cplans/basic_timeseries.cplan"
          dimension-quickview "Corporate Product Group"
          dimension-quickview "Product Name"
        }
        
        tab "Central Page" {
          screen {
            layout {
              vsplit {
                hsplit percent = 50 {
                  element id = "pc-respteam" percent = 50
                  element id = "tb-customer" percent = 50                
                }
                hsplit percent = 50 {
                  element id = "ln-brand"
                }
              }
            }
          } 
        }
      }
    }
  }
}

A map link opens a map, showing the designated location. The map location is determined by latitude and longitude coordinates.

Here is an example of a Closedcolumn that links to a map.

Example of a map link in a column.

Here is the Closedresult of the link to the Davis Square map in DiveTab.

Example of the result for the Davis Sq link.

Here is how the page appears in the code.

  report-page { 
    title "Map Link" 
    cplan "/cplans/lat-long.cplan" 
    dimension "Place" 
    
    location latlong-column = "calc-latlong" 
    location-distance { 
      link { 
        map column = "Lat-Long" 
      } 
    } 
    text "Map Me" { 
      link { 
        map column = "Lat-Long" 
      } 
    } 
  }

A page links leads to another DiveTab page within the same script file.

Here is an example of a Closedcolumn that links to another DiveTab page.

Example of a page linked to another DiveTab page.

Here is the Closedresult of the link to Division Manager's Daniel's page in DiveTab.

The resulting linked DiveTab page.

NOTE: This DiveTab page is contained within the same data-area block.

Here is how the page appears in the code.

  section { 
    report-page { 
      title "Page Link" 
      cplan "/cplans/distributor-dev.cplan" 
      
      dimension "Division Manager" 
      text column = "Bottles" { 
        link { 
          page id = "pg-target" 
        } 
      } 
    }
  } 
  
  pages { 
    report-page id = "pg-target" { 
      title "Target Page" 
      cplan "/cplans/distributor-dev.cplan" 
      
      parameter "Division Manager" 
      parameter "Premise" 
      dimension "Product Type" 
      text column = "Bottles" 
    } 
  }

NOTE: The use of a page parameter in this example identifies only the selected value as what is accepted by the target page. For example, the value for Daniel is followed, so only the values for Daniel are passed to the linked page.

Here is an example of a Closedcolumn that links to a web page.

Example of a page using a web page link.

Here is the Closedresult of the link in DiveTab.

The resulting linked web page.

Here is how the page appears in the code.

  report-page { 
    title "Web Page Link" 
    cplan "/cplans/distributor-dev.cplan" 
    
    dimension "Division Manager" 
    text column = "Bottles" { 
      link { 
        web-page "https://www.dimins.com/" 
      } 
    } 
  }